Skip to main content

List Applications

Overview​

The List Applications API returns a paginated list of applications accessible to the authenticated organization (including child organizations). You can filter by external reference, affiliate, status, creation date range, related person email, or company name.

Authentication​

This endpoint requires authentication. See API Authentication for detailed requirements and how to obtain credentials.

Endpoint​

GET /api/applications

Query Parameters​

ParameterTypeRequiredDescription
externalReferencestringNoExact match on the application external reference
affiliateIdstringNoFilter by affiliate MongoDB ObjectId
emailstringNoExact, case-insensitive match on a related person's email
companyNamestringNoCase-insensitive substring match on related company name
statusstringNoFilter by application status (see values below)
createdFromstringNoISO 8601 date string — include applications created on or after this time
createdTostringNoISO 8601 date string — include applications created on or before this time
pagenumberNoPage number (default: 1, minimum: 1)
limitnumberNoPage size (default: 20, minimum: 1, maximum: 100)

When both email and companyName are provided, results must match both filters.

Status Values​

enum ApplicationStatus {
   DRAFT = 'draft',
   PENDING = 'pending',
   REVIEWING = 'reviewing',
   REQUESTED = 'requested',
   PROVIDED = 'provided',
   APPROVED = 'approved',
   DECLINED = 'declined',
   CLOSED = 'closed',
}

Response Structure​

Interface Definitions​

interface ListApplicationsResponse {
   statusCode: number;
   data: {
      items: ApplicationListItem[];
      total: number;
      page: number;
      limit: number;
   };
}

interface ApplicationListItem {
   id: string;
   name: string;
   applicationStatus: ApplicationStatus;
   externalReference?: string;
   createdAt: string;
}

Success Response​

{
   "statusCode": 200,
   "data": {
      "items": [
         {
            "id": "68d24d26101f1f7ed2b5fcba",
            "name": "Acme Corp Application",
            "applicationStatus": "pending",
            "externalReference": "CRM-12345",
            "createdAt": "2026-09-17T10:30:00.000Z"
         }
      ],
      "total": 1,
      "page": 1,
      "limit": 20
   }
}

Empty Result​

{
   "statusCode": 200,
   "data": {
      "items": [],
      "total": 0,
      "page": 1,
      "limit": 20
   }
}

Field Validation Requirements​

  • affiliateId must be a valid MongoDB ObjectId when provided
  • status must be one of the ApplicationStatus enum values
  • createdFrom and createdTo must be valid ISO 8601 date strings
  • page must be an integer ≥ 1
  • limit must be an integer between 1 and 100

Usage Examples​

List with filters and pagination​

curl -X GET \
   'https://api.speedydd.com/api/applications?status=pending&page=1&limit=20&createdFrom=2026-09-01T00:00:00.000Z' \
   -H 'X-App-ID: your-app-id' \
   -H 'X-API-Key: your-api-key'

Filter by external reference​

curl -X GET \
   'https://api.speedydd.com/api/applications?externalReference=CRM-12345' \
   -H 'X-App-ID: your-app-id' \
   -H 'X-API-Key: your-api-key'